core/androidx.core.app/[main]ShareCompat/IntentReader

IntentReader

open class IntentReader(source)

IntentReader is a helper for reading the data contained within a sharing (ACTION_SEND) Intent. It provides methods to parse standard elements included with a share in addition to extra metadata about the app that shared the content.

Social sharing apps are encouraged to provide attribution for the app that shared the content. IntentReader offers access to the application label, calling activity info, and application icon of the app that shared the content. This data may have been provided voluntarily by the calling app and should always be displayed to the user before submission for manual verification. The user should be offered the option to omit this information from shared posts if desired.

Activities that intend to receive sharing intents should configure an intent-filter to accept ACTION_SEND intents ("android.intent.action.SEND") and optionally accept ACTION_SEND_MULTIPLE ("android.intent.action.SEND_MULTIPLE") if the activity is equipped to handle multiple data streams.

Constructors

constructor(@NonNull activity: @NonNull Activity)

Create an IntentReader for parsing and interpreting the sharing intent used to start the given activity.

constructor(@NonNull context: @NonNull Context, @NonNull intent: @NonNull Intent)

Create an IntentReader for parsing and interpreting the given sharing intent.

Functions

@NonNull

open fun ~~from~~(@NonNull activity: @NonNull Activity): @NonNull ShareCompat.IntentReader

Get an IntentReader for parsing and interpreting the sharing intent used to start the given activity.

getCallingActivity

@Nullable

open fun getCallingActivity(): @Nullable ComponentName

Get the ComponentName of the Activity that invoked this sharing intent.

getCallingActivityIcon

@Nullable

open fun getCallingActivityIcon(): @Nullable Drawable

Get the icon of the calling activity as a Drawable if data about the calling activity is available.

getCallingApplicationIcon

@Nullable

open fun getCallingApplicationIcon(): @Nullable Drawable

Get the icon of the calling application as a Drawable if data about the calling package is available.

getCallingApplicationLabel

@Nullable

open fun getCallingApplicationLabel(): @Nullable CharSequence

Get the human-readable label (title) of the calling application if data about the calling package is available.

getCallingPackage

@Nullable

open fun getCallingPackage(): @Nullable String

Get the name of the package that invoked this sharing intent.

open fun getEmailBcc(): @Nullable Array<String>

Get an array of Strings, each an email address to BCC on this share.

open fun getEmailCc(): @Nullable Array<String>

Get an array of Strings, each an email address to CC on this share.

open fun getEmailTo(): @Nullable Array<String>

Get an array of Strings, each an email address to share to.

@Nullable

open fun getHtmlText(): @Nullable String

Get the styled HTML text shared with the target activity.

@Nullable

open fun getStream(): @Nullable Uri

Get a URI referring to a data stream shared with the target activity.

@Nullable

open fun getStream(index: Int): @Nullable Uri

Get the URI of a stream item shared with the target activity.

open fun getStreamCount(): Int

Return the number of stream items shared.

@Nullable

open fun getSubject(): @Nullable String

Get a subject heading for this share; useful when sharing via email.

@Nullable

open fun getText(): @Nullable CharSequence

Get the literal text shared with the target activity.

@Nullable

open fun getType(): @Nullable String

Get the mimetype of the data shared to this activity.

isMultipleShare

open fun isMultipleShare(): Boolean

Returns true if the activity this reader was obtained for was started with an ACTION_SEND_MULTIPLE intent.

open fun isShareIntent(): Boolean

Returns true if the activity this reader was obtained for was started with an ACTION_SEND or ACTION_SEND_MULTIPLE sharing Intent.

open fun isSingleShare(): Boolean

Returns true if the activity this reader was obtained for was started with an ACTION_SEND intent and contains a single shared item.